CATEGORIES_FILTER

The CATEGORIES_FILTER element specifies which categories of log messages will be written to the log.

Syntax

 <CATEGORIES_FILTER> name [ ...]</CATEGORIES_FILTER>

The name is the filter name of a category of messages to write to the log. You can include multiple categories of messages by listing multiple filter names, separated by spaces. Table 1 lists the valid category filter names. The default categories are ERROR WARNING INFO, set by the resource $(res.log.categories_filter).

Table 1. Category filters
Filter Names	Description
`ERROR`	Log error information.
`WARNING`	Log warning messages.
`INFO`	Log information about the GAS version, build and package, and log summary information about the requests handled by the server. Sensitive and personal data is not written to the logs.
`DEBUG`	Log internal information for debugging, which may include sensitive or personal user data gathered during the normal course of running applications. Important: Do not set unless requested by your support center. Important: Sensitive and personal data may be written to the output. Make sure that the log output is written to files that can only be read by administrators, and review the management strategy for log files.
`ALL`	The `ALL` category is recommended for any exchange with Four Js support, as it gathers the information that support wants, and formats it in a consistent manner. It is very verbose; logs will be significantly larger when `ALL` is used. Some things to note: `ALL` enables all categories: `ERROR WARNING INFO DEBUG`. `ALL` activates all log columns. When the `ALL` category is enabled, `FORMAT` is ignored (even if it is set).

Child elements

There are no child elements.

Usage

You use this element to specify which categories of log messages to write to the log. It is an optional element of the LOG element. If it is omitted, the default messages for ERROR are logged.

With this example, all information, error and warning messages are written to the logs.

<CATEGORIES_FILTER>INFO ERROR WARNING</CATEGORIES_FILTER>

In production, it is recommended that you use only these categories: (INFO ERROR WARNING).

The ALL category is for debugging and should only be set for a short period of time, as it generates many log entries.

Your support center will tell you when you should set ALL for your categories filter.

Tip:

There are options to reconfigure logs for the running dispatcher or for a specific session using the gasadmin reset-log command.

Generate a detailed daily log file

If you encounter an issue, you can generate a detailed daily log file to send to your support center. To create the detailed daily log file, use the ALL category filter name.

<LOG>
  <OUTPUT Type="DAILYFILE">/work/tmp/gas</OUTPUT>
  <FORMAT>date time relative-time process-id thread-id contexts event-type event-params<FORMAT>
  <CATEGORIES_FILTER>ALL</CATEGORIES_FILTER>
</LOG>

Important:

If the CATEGORIES_FILTER is set to ALL, FORMAT is ignored.

This example generates various log files in the /work/tmp/gas directory, depending on the dispatcher and the application or service run.

Parent elements

This element is a child of the LOG element.